Please keep the following information in mind when editing the Wiki.

Making changes

This Wiki is provided by BitBucket and so you may want to consult the official BitBucket documentation when editing. Note that we are using Creole as our markup syntax.

The wiki itself is actually a git repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.

Go ahead and try:

$ git clone https://bitbucket.org/volumesoffun/polyvox.git/wiki

Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.

Versioning content

PolyVox is under continuous development and so many aspects of it are still changing. This means that Wiki material may cease to be accurate if it is not kept up to date, and so to avoid confusion we would encourage you to be clear about which version of PolyVox it was known to work with. To do this we suggest placing the following code snippet at the top of each page:

----
**[[Guidelines for editing the wiki|Last tested version of PolyVox:]] Version info goes here**
----

This looks as follows:

Last tested version of PolyVox: Version info goes here

You only need to do this if you content has information which might become out of date. This would include code snippets or descriptions of PolyVox's functionality. The version string can be what ever you feel is appropriate, such as 'Version X.Y', 'Shouldn't matter', or 'Unknown'. Please avoid updating code to work with the development version of PolyVox (the 'develop' branch) as it may well change further before release.

Licensing

All content on the Wiki is provided under the Creative Commons Zero Public Domain Dedication (CC0) unless otherwise stated. Please keep this in mind when adding content and be sure to mark clearly any code snippets or other content which are under a different license.

Syntax highlighting

You can also highlight snippets of text (we use the excellent Pygments) library).

Here's an example of some C++ code:

#include <iostream>

using namespace std;

int main(int argc, char** argv)
{
    cout << "Hello, world" << endl;
    return 0;
}

You can check out the source of this page to see how that's done, and make sure to bookmark the vast library of Pygment lexers, we accept the 'short name' or the 'mimetype' of anything in there.

Have fun!